<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="TileCanvas,com.jwopitz.containers.TileCanvas,enableAutoUpdate,enableMoveOnRefresh,enableRefreshOnMove,itemSpawnPoint,columnGap,columnWidth,columns,dataProvider,direction,dragEnabled,dragMoveEnabled,dropEnabled,itemAddOn,itemRenderer,rowGap,rowHeight,rows,calculateItemPosition,defaultItemAddOn,getItemInstance,getItemUnderMouse,updateDataProviderItems,updateItemLocations,updateRowsAndColumns" name="keywords">
<title>com.jwopitz.containers.TileCanvas</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'TileCanvas - API Documentation';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?com/jwopitz/containers/TileCanvas.html&amp;com/jwopitz/containers/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;TileCanvas</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class TileCanvas"); titleBar_setSubNav(false,true,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.jwopitz.containers</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class TileCanvas</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">TileCanvas <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> mx.containers.Canvas</td>
</tr>
</table>
<p></p>
  A TileCanvas container lays out its children in a grid of equal-sized cells based on the columnWidth and rowHeight values. 
  A TileCanvas container's direction property determines whether its cells are laid out horizontally or vertically, 
  beginning from the upper-left corner of the TileCanvas container.
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#columnGap">columnGap</a> : int<div class="summaryTableDescription">
   The amount of spacing between columns.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#columns">columns</a> : int<div class="summaryTableDescription">
   The maximum number of columns allowed.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#columnWidth">columnWidth</a> : int<div class="summaryTableDescription">
   The width of the columns.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#dataProvider">dataProvider</a> : Object<div class="summaryTableDescription">
   The set of data to be viewed.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#direction">direction</a> : String<div class="summaryTableDescription">
   Determines how children are placed in the container.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#dragEnabled">dragEnabled</a> : Boolean<div class="summaryTableDescription">
   A flag that indicates whether you can drag items out of this control and drop them on other controls.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#dragMoveEnabled">dragMoveEnabled</a> : Boolean<div class="summaryTableDescription">
   A flag that indicates whether items can be moved instead of just copied from the control as part of a drag-and-drop operation.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#dropEnabled">dropEnabled</a> : Boolean<div class="summaryTableDescription">
   A flag that indicates whether dragged items can be dropped onto the control.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#enableAutoUpdate">enableAutoUpdate</a> : Boolean = true<div class="summaryTableDescription">
   Flag indicating if the dataProvider will autoUpdate.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#enableMoveOnRefresh">enableMoveOnRefresh</a> : Boolean = true<div class="summaryTableDescription">
   Flag that determines if the animation effect takes place after the dataProvider refresh event is triggered.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#enableRefreshOnMove">enableRefreshOnMove</a> : Boolean = true<div class="summaryTableDescription">
   Flag indicating if the dataProvider gets refreshed after a drag and drop operation.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#itemAddOn">itemAddOn</a> : Function<div class="summaryTableDescription">
   Serves as a place to add extra functionality to the items generated from the itemRenderer.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#itemRenderer">itemRenderer</a> : IFactory<div class="summaryTableDescription">
   The custom item renderer for the control.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#itemSpawnPoint">itemSpawnPoint</a> : Point<div class="summaryTableDescription">
   Registers the x and y coordinates where new instances created by the itemRenderer will originate from.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#rowGap">rowGap</a> : int<div class="summaryTableDescription">
   The amount of spacing between rows.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#rowHeight">rowHeight</a> : int<div class="summaryTableDescription">
   The height of the rows.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#rows">rows</a> : int<div class="summaryTableDescription">
   The maximum number of rows allowed.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#TileCanvas()">TileCanvas</a>()</div>
<div class="summaryTableDescription">
   Constructor
   </div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
</table>
</div>
<a name="methodSummary"></a><a name="protectedMethodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Methods</div>
<table id="summaryTableProtectedMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#calculateItemPosition()">calculateItemPosition</a>(columnIndex:int, rowIndex:int):Point</div>
<div class="summaryTableDescription">
   Called for every item in the dataProvider to retrieve the appropriate x and y coordinates to move to.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#defaultItemAddOn()">defaultItemAddOn</a>(value:Container):void</div>
<div class="summaryTableDescription">
   An empty placeholder method called on each new instance generated from the itemRenderer.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getItemInstance()">getItemInstance</a>():Container</div>
<div class="summaryTableDescription">
   A convenience method for creating new instances from the itemRenderer and initializing certain properties.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#getItemUnderMouse()">getItemUnderMouse</a>():Container</div>
<div class="summaryTableDescription">
   Retreives the item under the mouse.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#updateDataProviderItems()">updateDataProviderItems</a>():void</div>
<div class="summaryTableDescription">
   If <code>enableRefreshOnMove == true</code> then a drag and drop operation will trigger a 
   reordering of the data in the dataProvider to reflect the data order in the list.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#updateItemLocations()">updateItemLocations</a>():void</div>
<div class="summaryTableDescription">
   Iterates through each item in the dataProvider to determine its column and row index based on the its position within
   the context of the maximum allowed columns or maximum allowed rows.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#updateRowsAndColumns()">updateRowsAndColumns</a>():void</div>
<div class="summaryTableDescription">
   Updates the number of actual rows and columns based on the number of items in the dataProvider.</div>
</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:columnsChange">columnsChange</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">&nbsp;</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:rowsChange">rowsChange</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">&nbsp;</td><td class="summaryTableOwnerCol">TileCanvas</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="columnGap"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">columnGap</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>columnGap:int</code>&nbsp;&nbsp;[read-write]<p>
   The amount of spacing between columns.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get columnGap():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set columnGap(value:int):void</code>
<br>
</div>
<a name="columns"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">columns</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>columns:int</code>&nbsp;&nbsp;[read-write]<p>
   The maximum number of columns allowed.  Once the number of items in the dataProvider exceeds the maxColumns per row,
   it positions the items in excess in the next row. This is dependant of the value of <code>direction</code>.
   </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get columns():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set columns(value:int):void</code>
<br>
</div>
<a name="columnWidth"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">columnWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>columnWidth:int</code>&nbsp;&nbsp;[read-write]<p>
   The width of the columns.  Each item in the dataProvider will be rendered to this width.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get columnWidth():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set columnWidth(value:int):void</code>
<br>
</div>
<a name="dataProvider"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">dataProvider</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>dataProvider:Object</code>&nbsp;&nbsp;[read-write]<p>
   The set of data to be viewed.
   </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get dataProvider():Object</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set dataProvider(value:Object):void</code>
<br>
</div>
<a name="direction"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">direction</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>direction:String</code>&nbsp;&nbsp;[read-write]<p>
   Determines how children are placed in the container.
   </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get direction():String</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set direction(value:String):void</code>
<br>
</div>
<a name="dragEnabled"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">dragEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>dragEnabled:Boolean</code>&nbsp;&nbsp;[read-write]<p>
   A flag that indicates whether you can drag items out of this control and drop them on other controls.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get dragEnabled():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set dragEnabled(value:Boolean):void</code>
<br>
</div>
<a name="dragMoveEnabled"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">dragMoveEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>dragMoveEnabled:Boolean</code>&nbsp;&nbsp;[read-write]<p>
   A flag that indicates whether items can be moved instead of just copied from the control as part of a drag-and-drop operation.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get dragMoveEnabled():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set dragMoveEnabled(value:Boolean):void</code>
<br>
</div>
<a name="dropEnabled"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">dropEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>dropEnabled:Boolean</code>&nbsp;&nbsp;[read-write]<p>
   A flag that indicates whether dragged items can be dropped onto the control.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get dropEnabled():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set dropEnabled(value:Boolean):void</code>
<br>
</div>
<a name="enableAutoUpdate"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">enableAutoUpdate</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var enableAutoUpdate:Boolean = true</code><p>
   Flag indicating if the dataProvider will autoUpdate.
   </p></div>
<a name="enableMoveOnRefresh"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">enableMoveOnRefresh</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var enableMoveOnRefresh:Boolean = true</code><p>
   Flag that determines if the animation effect takes place after the dataProvider refresh event is triggered.
   </p></div>
<a name="enableRefreshOnMove"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">enableRefreshOnMove</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var enableRefreshOnMove:Boolean = true</code><p>
   Flag indicating if the dataProvider gets refreshed after a drag and drop operation.
   </p></div>
<a name="itemAddOn"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">itemAddOn</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>itemAddOn:Function</code>&nbsp;&nbsp;[read-write]<p>
   Serves as a place to add extra functionality to the items generated from the itemRenderer.  
   For instance, it may be desired to have each item have a context menu on mouseEvents.
   A custom addOn function would be used to achieve this.
   The addOn function's signature is expected as <code>function (value:Container):void</code> 
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get itemAddOn():Function</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set itemAddOn(value:Function):void</code>
<br>
</div>
<a name="itemRenderer"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">itemRenderer</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>itemRenderer:IFactory</code>&nbsp;&nbsp;[read-write]<p>
   The custom item renderer for the control.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get itemRenderer():IFactory</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set itemRenderer(value:IFactory):void</code>
<br>
</div>
<a name="itemSpawnPoint"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">itemSpawnPoint</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public var itemSpawnPoint:Point</code><p>
   Registers the x and y coordinates where new instances created by the itemRenderer will originate from.
   </p></div>
<a name="rowGap"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">rowGap</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>rowGap:int</code>&nbsp;&nbsp;[read-write]<p>
   The amount of spacing between rows.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get rowGap():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set rowGap(value:int):void</code>
<br>
</div>
<a name="rowHeight"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">rowHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>rowHeight:int</code>&nbsp;&nbsp;[read-write]<p>
   The height of the rows.  Each item in the dataProvider will be rendered to this height.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get rowHeight():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set rowHeight(value:int):void</code>
<br>
</div>
<a name="rows"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">rows</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>rows:int</code>&nbsp;&nbsp;[read-write]<p>
   The maximum number of rows allowed.  Once the number of items in the dataProvider exceeds the maxRows per column,
   it positions the items in excess in the next column.  This is dependant of the value of <code>direction</code>. 
   </p><p>This property can be used as the source for data binding.</p>
<span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get rows():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set rows(value:int):void</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="TileCanvas()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">TileCanvas</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function TileCanvas()</code><p>
   Constructor
   </p></div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="calculateItemPosition()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">calculateItemPosition</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>protected function calculateItemPosition(columnIndex:int, rowIndex:int):Point</code><p>
   Called for every item in the dataProvider to retrieve the appropriate x and y coordinates to move to.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">columnIndex</span>:int</code> &mdash; The column position of the item.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">rowIndex</span>:int</code> &mdash; The row position of the item.
   
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Point</code> &mdash; The actual x and y coordinates based on the columnIndex and rowIndex for the item.
   </td>
</tr>
</table>
</div>
<a name="defaultItemAddOn()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">defaultItemAddOn</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function defaultItemAddOn(value:Container):void</code><p>
   An empty placeholder method called on each new instance generated from the itemRenderer.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Container</code> &mdash; The instance genereated from the itemRendere in which to add functionality.
   </td>
</tr>
</table>
</div>
<a name="getItemInstance()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getItemInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function getItemInstance():Container</code><p>
   A convenience method for creating new instances from the itemRenderer and initializing certain properties.
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Container</code> &mdash; A new instance from the itemRenderer.
   </td>
</tr>
</table>
</div>
<a name="getItemUnderMouse()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">getItemUnderMouse</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function getItemUnderMouse():Container</code><p>
   Retreives the item under the mouse.
   
   </p><p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code>Container</code> &mdash; The item under the mouse.
   </td>
</tr>
</table>
</div>
<a name="updateDataProviderItems()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">updateDataProviderItems</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function updateDataProviderItems():void</code><p>
   If <code>enableRefreshOnMove == true</code> then a drag and drop operation will trigger a 
   reordering of the data in the dataProvider to reflect the data order in the list. 
   </p></div>
<a name="updateItemLocations()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">updateItemLocations</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function updateItemLocations():void</code><p>
   Iterates through each item in the dataProvider to determine its column and row index based on the its position within
   the context of the maximum allowed columns or maximum allowed rows.
   
   </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">calculateItemPosition</div>
</div>
<a name="updateRowsAndColumns()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">updateRowsAndColumns</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protected function updateRowsAndColumns():void</code><p>
   Updates the number of actual rows and columns based on the number of items in the dataProvider.
   </p></div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:columnsChange"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">columnsChange</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>flash.events.Event</code></a>
<br>
<p></p>
</div>
<a name="event:rowsChange"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">rowsChange</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href=""><code>flash.events.Event</code></a>
<br>
<p></p>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
